GET FormTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves form types for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
| take |
Number of form types to retrieve. Default is all form types |
integer |
None. |
| skip |
Number of form types to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the form types before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of form types.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of FormType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"FormTypeId": "a66b7480-4efd-4677-9099-0ef69204e579",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a660869d-1e8d-4d7c-8dfc-098307ca2d98",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "021cd781-72a2-4227-8291-8c461151f42f",
"CreateDate": "2024-04-28T14:08:10.900483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T14:08:10.900483-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2024-04-28T14:08:10.900483-07:00",
"Fields": [
{
"FormTypeFieldId": "adae25cc-2203-4e43-b02d-3dd170dbe2ab",
"Section": {
"FormTypeSectionId": "0092768b-5f2b-4da0-98ba-ec95a186e972",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "6fe9fa28-7b74-4f6f-a187-7f4ab0785644",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "07d11965-24c8-4514-9168-e189f19f882e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "775a7382-366a-4d99-beba-627ec340b145",
"CreateDate": "2024-04-28T14:08:10.900483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T14:08:10.900483-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "adae25cc-2203-4e43-b02d-3dd170dbe2ab",
"Section": {
"FormTypeSectionId": "0092768b-5f2b-4da0-98ba-ec95a186e972",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "6fe9fa28-7b74-4f6f-a187-7f4ab0785644",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "07d11965-24c8-4514-9168-e189f19f882e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "775a7382-366a-4d99-beba-627ec340b145",
"CreateDate": "2024-04-28T14:08:10.900483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T14:08:10.900483-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d2a73ae1-87f3-46e1-ac49-f061d4e82e34",
"CreateDate": "2024-04-28T14:08:10.900483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T14:08:10.900483-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "a66b7480-4efd-4677-9099-0ef69204e579",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a660869d-1e8d-4d7c-8dfc-098307ca2d98",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "021cd781-72a2-4227-8291-8c461151f42f",
"CreateDate": "2024-04-28T14:08:10.900483-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T14:08:10.900483-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2024-04-28T14:08:10.900483-07:00",
"Fields": [
{
"FormTypeFieldId": "adae25cc-2203-4e43-b02d-3dd170dbe2ab",
"Section": {
"FormTypeSectionId": "0092768b-5f2b-4da0-98ba-ec95a186e972",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "6fe9fa28-7b74-4f6f-a187-7f4ab0785644",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "07d11965-24c8-4514-9168-e189f19f882e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "775a7382-366a-4d99-beba-627ec340b145",
"CreateDate": "2024-04-28T14:08:10.900483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T14:08:10.900483-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "adae25cc-2203-4e43-b02d-3dd170dbe2ab",
"Section": {
"FormTypeSectionId": "0092768b-5f2b-4da0-98ba-ec95a186e972",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "6fe9fa28-7b74-4f6f-a187-7f4ab0785644",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "07d11965-24c8-4514-9168-e189f19f882e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "775a7382-366a-4d99-beba-627ec340b145",
"CreateDate": "2024-04-28T14:08:10.900483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T14:08:10.900483-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d2a73ae1-87f3-46e1-ac49-f061d4e82e34",
"CreateDate": "2024-04-28T14:08:10.900483-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T14:08:10.900483-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}